feat: Process TSV files as streams and validate only the first 1000 rows by default #139
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
effigies
commented
Jan 9, 2025
| const normalizeEOL = (str: string): string => str.replace(/\r\n/g, '\n').replace(/\r/g, '\n') | ||
| // Typescript resolved `row && !/^\s*$/.test(row)` as `string | boolean` | ||
| const isContentfulRow = (row: string): boolean => !!(row && !/^\s*$/.test(row)) | ||
| async function _loadTSV(file: BIDSFile, maxRows: number = -1): Promise<ColumnsMap> { |
There was a problem hiding this comment.
This file in particular will be easiest to review just by reading the new file, as the contents are almost entirely new.
effigies
force-pushed
the
feat/tsv-maxrows
branch
from
ef7442a to
cfe5120
Compare
effigies
commented
Jan 10, 2025
effigies
force-pushed
the
feat/tsv-maxrows
branch
from
eb6e002 to
fe9d3e4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is an optimization. In #138 we found a case with >300k lines in a TSV file. In order to limit the number of lines being inspected, I needed to switch TSV loading to be stream-based instead of slurping the entire file.
This PR does the following:
\r?\n--max-rowsflag to the CLI and amaxRowsvariable to validator options.Note that this adds a new error condition, where we tolerate empty lines only at the end of files (
<content><LF><EOF>). In passing, this permits us to report the line number of bad TSV lines.I also do not attempt to addI added arguments to the cache key inmaxRowsto the TSV cache key, so callingloadTSV()successively on the same file and differentmaxRowsvalues will return the result from the first call. This does not seem like a problem in terms of running the validator, but might be surprising to future developers. I can look into that, if desired.filememoizeAsync.Closes #138.